/*
 * JHeuristics - The Java Meta-Heuritics Library
 * Copyright (C) 2004-2005, Universidade Federal de Campina Grande. All rights reserved.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package org.jheuristics.ga.operators;

import org.jheuristics.ga.DefaultPopulation;
import org.jheuristics.ga.GAConfig;
import org.jheuristics.ga.GAStatus;
import org.jheuristics.ga.Operator;
import org.jheuristics.ga.Population;

/**
 * TODO
 *
 * @author Marcell Manfrin, marcell@ourgrid.org, Jan 9, 2006
 */
public abstract class AbstractSelectionOperator implements Operator {
	private Rate rate;
	private Selector selector;

	/**
	 * TODO
	 *
	 * @param rate
	 * @param selector
	 */
	public AbstractSelectionOperator(Rate rate, Selector selector) {
		setRate(rate);
		setSelector(selector);
	}

	/**
	 * TODO
	 *
	 * @param status
	 * @param config
	 * @see org.jheuristics.ga.Operator#operate(org.jheuristics.ga.GAStatus, org.jheuristics.ga.GAConfig)
	 */
	public abstract void operate(GAStatus status, GAConfig config);

	/**
	 * TODO
	 *
	 * @param population
	 * @param status
	 * @param config
	 * @return
	 */
	protected Population select(Population population, GAStatus status, GAConfig config) {
        Population result = new DefaultPopulation();
        Selector selector = getSelector();
        int rate = getRate().rate(status, config);

        result.addIndividuals(selector.select(population, rate, status, config));
        return result;
	}

	/**
	 * TODO
	 *
	 * @return Returns the rate.
	 */
	public Rate getRate() {
		return rate;
	}

	/**
	 * TODO
	 *
	 * @param rate The rate to set.
	 */
	public void setRate(Rate rate) {
		if (null == rate) {
			// TODO: ERROR MSG
			throw new NullPointerException();
		}
		this.rate = rate;
	}

	/**
	 * TODO
	 *
	 * @return Returns the selector.
	 */
	public Selector getSelector() {
		return selector;
	}

	/**
	 * TODO
	 *
	 * @param selector The selector to set.
	 */
	public void setSelector(Selector selector) {
		if (null == selector) {
			// TODO: ERROR MSG
			throw new NullPointerException();
		}
		this.selector = selector;
	}

}
